home *** CD-ROM | disk | FTP | other *** search
/ Shareware Overload Trio 2 / Shareware Overload Trio Volume 2 (Chestnut CD-ROM).ISO / dir42 / dctrpt.zip / DCTRPT.TXT < prev   
Text File  |  1994-05-08  |  5KB  |  125 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.                          Dictionary Reporter
  7.  
  8.                             Version 1.0
  9.  
  10.  
  11.  
  12.                    Author:   David Zaremba
  13.                              216-221-6600 (work) 
  14.                              216-221-9742 (fax)
  15.  
  16.                    70042,1446  (CompuServe, personal)
  17.                    74143,3400  (CompuServe, Corporate)
  18.  
  19.  
  20.  
  21.  
  22. DISCLAIMER:  While this program does not modify the Data Dictionary
  23. in any way, information regarding the layout of the Data Dictionary
  24. was obtained without any assistance from Clarion.  As such, the
  25. information reported on is not guaranteed to be accurate. 
  26. Furthermore, user of this program assumes all risks related to its
  27. use.
  28.  
  29.  
  30. Dictionary Reporter was created with two goals in mind.  Goal one
  31. was to be able to print out documentation on the Clarion Data
  32. Dictionary in a developer defined format.  To enable this goal,
  33. goal two was to decipher the Data Dictionary.  Application
  34. Generator was used as much as possible.  In fact, it could have
  35. been used a bit more (some of the embedded source could have been
  36. created through the Formula Generator, etc.), but in the interests
  37. of time, and to avoid some of the problems of Formula Generator
  38. (such as its insistence on evaluating Formulas in alphabetical
  39. order as opposed to entry order), embedded source was used.
  40.  
  41. To allow a developer to tailor the reports to their own needs, 
  42. Dictionary Reporter is being distributed with the .DCT and .APP
  43. files.
  44.  
  45. All fields in the Data Dictionary (except for relations at this
  46. point) should be in the reports.  If not, please let me know so I
  47. can update the record layouts on reports. 
  48.  
  49. I also have Browse/Form screens under development to allow on-
  50. screen display of what's on the reports.  The idea is to allow
  51. editing of this information.  Because of certain data
  52. relationships, this is not a simple thing (for example, not only is
  53. a field saved, but so is its length, and multiple such fields are
  54. concatenated together upon saving).  To be honest I would recommend
  55. ALWAYS using Clarion's Data Dictionary.  But for those adventurous
  56. ones, I'll release these enhancements at a future time.  Relation
  57. reporting and screens will also be released.  
  58.  
  59. A number have asked about the .APP file layout.  I have looked at
  60. it, and while conceptually similar to the .DCT file, it is
  61. naturally more involved.  As I get time, I'll be exploring
  62. reporting and additional access to it.
  63.  
  64. This was not intended to be an exercise in programming style or
  65. ability.  This project was done in very small time frames (10 or 15
  66. minutes here and there).  Looking back over everything, I can
  67. already see plenty that I COULD have done differently.  If I get a
  68. chance, I'll improve the coding itself.  But for now, it works, and
  69. that's what matters most.
  70.  
  71. This project was coded using CDD 3.008 and Dictionary Version 8. 
  72. Previous or future dictionary versions cannot be guaranteed to
  73. produce accurate reports.
  74.  
  75. Feel free to make ask any questions or make any comments, or
  76. criticisms.
  77.  
  78.  
  79.  
  80.  
  81. Use of Dictionary Reporter:
  82.  
  83. Using Dictionary Reporter is straight forward.  Make sure Btrieve
  84. is loaded before running the program.  Recommended parameters are
  85. those used in the CDD.BAT file used by Clarion.  Then simply type
  86. DCTRPT.  Upon startup, you will be presented with a standard file
  87. selection screen.  Simply select the Data Dictionary to be reported
  88. on.  This selection can be changed later within the program by
  89. selecting 'Dictionary' from the Main Menu.
  90.  
  91. Once in the program, simply select which portion of the Data
  92. Dictionary you want a report of (Files, Keys, Memos, or Fields). 
  93. File Relations are not supported for reporting in this release at
  94. this time, but will be available in the future.  You can select the
  95. output destination (via the standard Clarion Redirect template).
  96.  
  97.  
  98.  
  99. Basic Dictionary Layout:
  100.  
  101. The Dictionary is laid out using variable length records.
  102.  
  103. The fixed length portion contains File, Key, Memo, Field and
  104. Relation Labels as well as the Dates and Times the record was
  105. created and last modified.  There is also a Record Type field which
  106. identifies what type of record it is (File, Key, Memo, Field, or
  107. Relation).
  108.  
  109. The variable length portion contains the information specific to
  110. its record type.  At the beginning of this variable length portion
  111. is a series of BYTE or USHORT fields that contain the lengths of
  112. the various pieces or fields of information.  This section is
  113. followed by a potentially long STRING field that contains all the
  114. values concatenated together.  To extract a specific piece of
  115. information, simply add up all the field lengths prior to the field
  116. you want (this creates an offset) and then pull out the information
  117. for a length equal to what is specified for this field in the first
  118. portion mentioned above.
  119.  
  120.  
  121. That is a very basic description of the dictionary layout.  Much
  122. more can be learned by simply going through the included .DCT and
  123. .APP file.  If you have any questions, please feel free to ask. 
  124.  
  125.